.. _Description of all parameters.json#/:

Description of all parameters
=============================

The parameters in the parset are divided into several groups like input (msin), output (msout), madflagger, average, preflagger, and uvwflagger.  Because multiple flagging and averaging steps can be specified, their parameters have to be prefixed with the step name as shown in the example above.


.. _Description of all parameters.json#/inputs:

inputs
******


.. _Description of all parameters.json#/inputs/checkparset:

checkparset
+++++++++++

:type: ``integer``

:default: ``0``

:doc: What to do if parameters in the ParSet file are not used. -1 means ignore. 0 means give a warning showing those parameters. In this way misspelled parameters can be detected. 1 means give an error and stop. For backward compatibility False (0) and True (1) can also be given `.`


.. _Description of all parameters.json#/inputs/memory_logging:

memory_logging
++++++++++++++

:type: ``bool``

:default: ``False``

:doc: ``If true``, ``a current amount of memory in use by Dp3 (in Gb) is added before any logged messages on the console.``


.. _Description of all parameters.json#/inputs/numthreads:

numthreads
++++++++++

:type: ``int``

:default: ``${OMP_NUM_THREADS}``

:doc: Maximum number of threads to use `.`


.. _Description of all parameters.json#/inputs/showcounts:

showcounts
++++++++++

:type: ``bool``

:default: ``True``

:doc: Show flagging statistics `?`


.. _Description of all parameters.json#/inputs/showprogress:

showprogress
++++++++++++

:type: ``bool``

:default: ``True``

:doc: Show a progress bar `?`


.. _Description of all parameters.json#/inputs/showtimings:

showtimings
+++++++++++

:type: ``bool``

:default: ``True``

:doc: At the end the percentage of elapsed time each step took can be shown; the overall time is always shown `.`


.. _Description of all parameters.json#/inputs/steps:

steps
+++++

:type: ``string?``

:doc: Names of the steps to perform. Each step has to be defined using the step name as a prefix. The step ``type`` parameter defines the type of step (averager, madflagger, preflagger, uvwflagger, counter). The step type defaults to the name of the step, which is especially handy for count steps. ``msin`` and ``msout`` are implicit steps which should not be given here. An empty vector ``[]`` means that the input MS is copied to the output MS while flagging NaN and infinite numbers. Note that a step name can be used more than once meaning that the same step will be executed multiple times (e.g., multiple times count) `.`


.. _Description of all parameters.json#/inputs/time_logging:

time_logging
++++++++++++

:type: ``bool``

:default: ``False``

:doc: ``If true``, ``a time is added before any logged messages on the console.``


.. _Description of all parameters.json#/inputs/verbosity:

verbosity
+++++++++

:type: ``string``

:default: ``normal``

:doc: ``Verbosity level of console output. Options are: "quiet" to only output errors; "normal" to output errors``, ``warnings and info messages; or "verbose" which additionally outputs debug messages.``